Open
Conversation
Signed-off-by: Umberto Sgueglia <usgueglia@contractor.linuxfoundation.org>
|
|
Signed-off-by: Umberto Sgueglia <usgueglia@contractor.linuxfoundation.org>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an OpenAPI specification for the Public v1 “Affiliations” endpoints to document bulk and single-handle contributor affiliation lookups.
Changes:
- Introduces a new
openapi.yamldescribingPOST /affiliations(bulk lookup with pagination) andGET /affiliations/{githubHandle}(single lookup). - Defines request/response schemas and common error responses (400/401/403/404/429) for the Affiliations API.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Umberto Sgueglia <usgueglia@contractor.linuxfoundation.org>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note
Low Risk
Documentation-only change adding an OpenAPI contract; no runtime code paths are modified.
Overview
Adds a new OpenAPI 3.1 spec (
backend/src/api/public/v1/affiliations/openapi.yaml) documenting the public Affiliations API, includingPOST /affiliations(bulk lookup with pagination) andGET /affiliations/{githubHandle}(single lookup).Defines the request/response schemas (
Contributor,AffiliationPeriod,BulkAffiliationsResponse) plus standard error responses and bearer API-key security requirements.Written by Cursor Bugbot for commit d9e3718. This will update automatically on new commits. Configure here.